Terraform Modules: Quick Overview

Terraform is a tool used for managing infrastructure as code (IaC). Using modules in Terraform helps organize and reuse code efficiently. In this article, we will focus on the best practices for using Terraform modules, with a simple EC2 module example to demonstrate how to create and manage AWS EC2 instances.

What Are Terraform Modules?

A module in Terraform is a reusable container for your infrastructure code. It consists of a set of resources (like EC2 instances, security groups, etc.) grouped together. Modules make your code more organized and reusable, and they help reduce duplication.

Benefits of Using Terraform Modules

• Reusability: You can use the same module in multiple places or projects.
• Maintainability: Changes can be made in one place, making your infrastructure easier to manage.
• Clarity: Modules help break down complex infrastructure into simpler, smaller parts.

Best Practices for Terraform Modules

1. Keep Modules Simple and Focused

Each module should do just one thing. For example, an EC2 module should only handle EC2 instances and not deal with other resources like S3 buckets or security groups. Keeping modules focused makes them easier to manage and understand.

2. Use Variables for Flexibility

Variables allow users to configure a module without changing its code. By defining variables, you can make your module more flexible and adaptable to different environments.

variable "instance_type" {
    description = "The type of EC2 instance"
    type        = string
    default     = "t2.micro"
}

variable "ami_id" {
    description = "The AMI ID for the EC2 instance"
    type        = string
}
            

3. Provide Outputs for Useful Information

Outputs let users retrieve information from the module after it is applied. In an EC2 module, useful outputs might include the instance ID and public IP:

output "instance_id" {
    description = "The ID of the EC2 instance"
    value       = aws_instance.example.id
}

output "public_ip" {
    description = "The public IP address of the EC2 instance"
    value       = aws_instance.example.public_ip
}
            

4. Document Your Module

Each module should have a README file that explains how to use it. The README should include:

• Inputs: A list of variables and their descriptions.
• Outputs: The values the module returns.
• Usage Example: How to use the module in a Terraform configuration.

5. Version Control for Compatibility

Always specify the versions of Terraform and the provider in your module to avoid compatibility issues. For example:

terraform {
  required_version = ">= 1.0"

  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.0"
    }
  }
}
            

6. Test Your Module

Before using a module in production, always test it. Use Terraform commands like terraform plan and terraform apply to make sure everything works as expected.

Simple EC2 Module Example

Let’s walk through a simple EC2 module example. This module will create an EC2 instance in AWS. Below is how you can structure the module:

Directory Structure

ec2-module/
├── main.tf
├── variables.tf
├── outputs.tf
├── README.md
            

main.tf: Define the EC2 Instance

resource "aws_instance" "example" {
  ami           = var.ami_id
  instance_type = var.instance_type

  tags = {
    Name = "ExampleEC2"
  }
}
            

variables.tf: Define Input Variables

variable "instance_type" {
  description = "Type of EC2 instance"
  type        = string
  default     = "t2.micro"
}

variable "ami_id" {
  description = "AMI ID for EC2 instance"
  type        = string
}
            

outputs.tf: Define Outputs

output "instance_id" {
  description = "The ID of the EC2 instance"
  value       = aws_instance.example.id
}

output "public_ip" {
  description = "The public IP of the EC2 instance"
  value       = aws_instance.example.public_ip
}
            

Usage Example

To use the EC2 module, create a Terraform configuration like this:

module "ec2_instance" {
  source      = "./ec2-module"
  ami_id      = "ami-0c55b159cbfafe1f0"
  instance_type = "t2.medium"
}